FlowMailSender
Handles the process of sending emails within the workflow with customizable options.
Properties
| Name | Description |
|---|---|
| Key | A unique identifier for the workflow step. |
| FromAddress | The email address of the sender. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| TO | The list of primary recipients of the email. |
| TypeCode | The type code associated with the flow object. |
| BCC | The list of recipients to be blind-copied on the email. |
| ValueType | Specifies the type of the value used in the email process. |
| ValueSourceType | Defines the source type of the value used in the email process. |
| Attachments | A list of attachments to include in the email. |
| ResumeOnError | Indicates whether the email sending process should continue on error. (Deprecated) |
| ErrorDescriptionObjectName | Specifies the object name for error descriptions. (Deprecated) |
| ErrorOptions | Defines error-related options for the API step. |
| Name | Name for the workflow step. |
| Value | The dynamic value used during the email sending process. |
| DisplayName | The display name of the sender. |
| Message | The main content of the email to be sent. |
| IsHtml | Determines whether the email content is in HTML format. |
| ReadNotification | Determines whether to enable read notifications for the email. |
| CC | The list of recipients to be copied on the email. |
| Caption | The caption dictionary representing localized captions for the flow object. |
| Subject | The subject of the email. |
| Culture | Specifies the culture or language used in the email content. |
Constructors
| Name | Description |
|---|---|
| FlowMailSender(name, workflowData, workflowCodeInstance) | Constructor for the FlowMailSender class. Initializes a new instance of the FlowMailSender class. |
| FlowMailSender(name, workflowData, workflowCodeInstance) | Initializes a new instance of the FlowMailSender class. |
| FlowMailSender(name,workflowData,workflowCodeInstance) | Initializes a new instance of the FlowMailSender class with a name, workflow data, and workflow code instance. |
Methods
| Name | Description |
|---|---|
| RemoveBCC(recipient) | Removes a recipient from the BCC list of the email. |
| ClearCC() | Clears all CC recipients from the email. |
| AddTO(recipient) | Adds a primary recipient to the email. |
| AddRecipientCC(recipient) | Adds a recipient to the CC list using recipient options. |
| AddCC(recipient) | Adds a recipient to the CC (carbon copy) list of the email. |
| ClearBCC() | Clears all BCC recipients from the email. |
| AddRecipientBCC(recipient) | Adds a recipient to the BCC list using recipient options. |
| Initialize() | Initializes the FlowMailSender with default configurations. |
| AddRecipientTO(recipient) | Adds a recipient to the primary recipients list using recipient options. |
| ClearTO() | Clears all primary recipients from the email. |
| AddAttachment(value, type) | Adds an attachment to the email. |
| RemoveTO(recipient) | Removes a primary recipient from the email. |
| AddBCC(recipient) | Adds a recipient to the BCC (blind carbon copy) list of the email. |
| RemoveCC(recipient) | Removes a recipient from the CC list of the email. |
| Send() | Sends the email with the configured settings. |
Events
| Name | Description |
|---|---|
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
Generic Types
| Name | Description |
|---|---|
| TProperties | Generic type of properties. |